Saltar para o conteúdo principal
GET
[BETA] Get Toppie Campaign Details

Autorizações

Authorization
string
header
obrigatório

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Parâmetros de caminho

campaign-id
string<uuid>
obrigatório

The ID of the campaign.

Resposta

Successful Response

Represents a public version of an agency campaign, used in API responses.

id
string<uuid>
obrigatório

Internal identifier for the agency campaign

name
string
obrigatório

Campaign name

adFormat
enum<string>
obrigatório

The ad format for this campaign

Opções disponíveis:
banner,
listing
chargeType
enum<string>
obrigatório

The charge type for this campaign

Opções disponíveis:
CPM,
CPC,
CPA
accountId
string<uuid>
obrigatório

Account that owns this campaign

budget
integer
obrigatório

Total budget for this campaign

budgetPeriod
enum<string>
obrigatório

The periodicity of the budget

Opções disponíveis:
daily,
weekly,
monthly,
total
startDate
string<date-time>
obrigatório

Date when the campaign starts, specified in RFC 3339. Must include the Timezone definition.

endDate
string<date-time>
obrigatório

Date when the campaign ends, specified in RFC 3339. Must include the Timezone definition.

targetRoas
number
obrigatório

Target ROAS for the campaign

Intervalo necessário: 0.5 <= x <= 20
currencyCode
string
obrigatório

Currency code this campaign is working with in ISO 4217 format

Exemplo:

"USD"

isActive
boolean
obrigatório

Flag to indicate if the campaign is active or not

createdAt
string<date-time>
obrigatório

Date and time when the campaign was created

bidCount
integer | null

Bid count for the campaign (optional)